<html><head>
<link href="style.css" rel="stylesheet" type="text/css"/>
<title>Thrift module: Errors</title></head><body>
<h1>Thrift module: Errors</h1>
<table><tr><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></tr>
<tr>
<td>Errors</td><td></td>
<td><a href="Errors.html#Enum_EDAMErrorCode">EDAMErrorCode</a><br/>
<a href="Errors.html#Struct_EDAMNotFoundException">EDAMNotFoundException</a><br/>
<a href="Errors.html#Struct_EDAMSystemException">EDAMSystemException</a><br/>
<a href="Errors.html#Struct_EDAMUserException">EDAMUserException</a><br/>
</td>
<td><code></code></td>
</tr></table>
<hr/><h2 id="Enumerations">Enumerations</h2>
<div class="definition"><h3 id="Enum_EDAMErrorCode">Enumeration: EDAMErrorCode</h3>
Numeric codes indicating the type of error that occurred on the
service.
<dl>
  <dt>UNKNOWN</dt
    <dd>No information available about the error</dd>
  <dt>BAD_DATA_FORMAT</dt>
    <dd>The format of the request data was incorrect</dd>
  <dt>PERMISSION_DENIED</dt>
    <dd>Not permitted to perform action</dd>
  <dt>INTERNAL_ERROR</dt>
    <dd>Unexpected problem with the service</dd>
  <dt>DATA_REQUIRED</dt>
    <dd>A required parameter/field was absent</dd>
  <dt>LIMIT_REACHED</dt>
    <dd>Operation denied due to data model limit</dd>
  <dt>QUOTA_REACHED</dt>
    <dd>Operation denied due to user storage limit</dd>
  <dt>INVALID_AUTH</dt>
    <dd>Username and/or password incorrect</dd>
  <dt>AUTH_EXPIRED</dt>
    <dd>Authentication token expired</dd>
  <dt>DATA_CONFLICT</dt>
    <dd>Change denied due to data model conflict</dd>
  <dt>ENML_VALIDATION</dt>
    <dd>Content of submitted note was malformed</dd>
  <dt>SHARD_UNAVAILABLE</dt>
    <dd>Service shard with account data is temporarily down</dd>
</dl>
<br/><br/><table>
<tr><td><code>UNKNOWN</code></td><td><code>1</code></td></tr>
<tr><td><code>BAD_DATA_FORMAT</code></td><td><code>2</code></td></tr>
<tr><td><code>PERMISSION_DENIED</code></td><td><code>3</code></td></tr>
<tr><td><code>INTERNAL_ERROR</code></td><td><code>4</code></td></tr>
<tr><td><code>DATA_REQUIRED</code></td><td><code>5</code></td></tr>
<tr><td><code>LIMIT_REACHED</code></td><td><code>6</code></td></tr>
<tr><td><code>QUOTA_REACHED</code></td><td><code>7</code></td></tr>
<tr><td><code>INVALID_AUTH</code></td><td><code>8</code></td></tr>
<tr><td><code>AUTH_EXPIRED</code></td><td><code>9</code></td></tr>
<tr><td><code>DATA_CONFLICT</code></td><td><code>10</code></td></tr>
<tr><td><code>ENML_VALIDATION</code></td><td><code>11</code></td></tr>
<tr><td><code>SHARD_UNAVAILABLE</code></td><td><code>12</code></td></tr>
</table></div>
<hr/><h2 id="Structs">Data structures</h2>
<div class="definition"><h3 id="Struct_EDAMUserException">Exception: EDAMUserException</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>errorCode</td><td><code><a href="Errors.html#Enum_EDAMErrorCode">EDAMErrorCode</a></code></td><td>yes</td><td></td></tr>
<tr><td>parameter</td><td><code>string</code></td><td>no</td><td></td></tr>
</table><br/>This exception is thrown by EDAM procedures when a call fails as a result of
a problem that a user may be able to resolve.  For example, if the user
attempts to add a note to their account which would exceed their storage
quota, this type of exception may be thrown to indicate the source of the
error so that they can choose an alternate action.
<p/>
This exception would not be used for internal system errors that do not
reflect user actions, but rather reflect a problem within the service that
the user cannot resolve.
<p/>
errorCode:  The numeric code indicating the type of error that occurred.
  must be one of the values of EDAMErrorCode.
<p/>
parameter:  If the error applied to a particular input parameter, this will
  indicate which parameter.
<br/></div><div class="definition"><h3 id="Struct_EDAMSystemException">Exception: EDAMSystemException</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>errorCode</td><td><code><a href="Errors.html#Enum_EDAMErrorCode">EDAMErrorCode</a></code></td><td>yes</td><td></td></tr>
<tr><td>message</td><td><code>string</code></td><td>no</td><td></td></tr>
</table><br/>This exception is thrown by EDAM procedures when a call fails as a result of
an a problem in the service that could not be changed through user action.
<p/>
errorCode:  The numeric code indicating the type of error that occurred.
  must be one of the values of EDAMErrorCode.
<p/>
message:  This may contain additional information about the error
<br/></div><div class="definition"><h3 id="Struct_EDAMNotFoundException">Exception: EDAMNotFoundException</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>identifier</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>key</td><td><code>string</code></td><td>no</td><td></td></tr>
</table><br/>This exception is thrown by EDAM procedures when a caller asks to perform
an operation that does not exist.  This may be thrown based on an invalid
primary identifier (e.g. a bad GUID), or when the caller refers to an object
by another unique identifier (e.g. a User's email address).
<p/>
identifier:  the object identifier that was not found on the server.
<p/>
key:  the value passed from the client in the identifier, which was not
  found.  E.g. the GUID of an object that was not found.
<br/></div></body></html>
